Skip to main content

Get First Land Based Receiver Events

Method: GET
/data-provider/events/first-land-based-receiver

As a Data Provider of iFoodDS, you use the iFoodDS First Land Based Receiver (FLBR) Event API to query FLBR event data from the iFoodDS Trace Exchange platform.

info

This endpoint is being refined and thus subject to change. These docs will update when changes are made.

Request​

Type: application/json

Retrieving FLBR events via the API is done through paging. The request requires a series of query parameters which define the page that must be returned. These parameters must be supplied in the url when the get is executed in order to return the result set for the page being queried.

Query Parameters​

Optional​

  • page (number): The page index of the events to return. The first page is index 0.
  • size (number): The number of results to return per page. Default value is 20.
  • submitStartDateTime (datetime): Filters results to include only events submitted after the specified date and time.
  • submitEndDateTime (datetime): Filters results to include only events submitted before the specified date and time.
  • eventStartDateTime (datetime): Filters results to include only events with an event date and time after the specified date and time.
  • eventEndDateTime (datetime): Filters results to include only events with an event date and time before the specified date and time.
  • harvestLocationCode (string): The exact location code of seafood harvesting for the event.
  • receivedLocationCode (string): The exact received location code for the event.
  • receivedDocumentLineNumber (string): The exact received document line number for the event.
  • receivedItemCode (string): The exact product received code for the event.

Data Constraints​

Please note the following data constraints:

  • datetimes must use the format: yyyy-MM-ddTHH:mm:ss

Response​

Return result for the first land based receiver event data queried.

{
    "content": [
        {
            "id": "<event id>",
            "dataProviderVendorId": "<data provider vendor ID>",
            "dataProviderVendorName": "<data provider vendor name>",
            "eventDateTime": "<event date>",
            "harvestDateStart": "<harvest start date>",
            "harvestDateEnd": "<harvest end date>",
            "documentNumber": "<document number>",
            "harvestLocation": {
                "id": "<location id>",
                "gln": "<gln>",
                "city": "<city>",
                "duns": "<duns>",
                "state": "<state>",
                "market": "<market>",
                "region": "<region>",
                "country": "<country>",
                "geoFence": "<geo fence>",
                "postalCode": "<postal code>",
                "phoneNumber": "<phone number>",
                "businessUnit": "<business unit>",
                "locationName": "<location name>",
                "locationType": "<location type>",
                "glnAssignedBy": "<gln assigned by>",
                "gpsCoordinates": "<gps coordinates>",
                "streetAddress1": "<street address 1>",
                "streetAddress2": "<street address 2>",
                "isCoveredByGdst": <is covered by gdst>,
                "parentLocationId": "<parent location id>",
                "isPrimaryLocation": <is primary location>,
                "alternateLocationId": "<alternate location id>"
            },
            "receiveLocation": {
                "id": "<location id>",
                "gln": "<gln>",
                "city": "<city>",
                "duns": "<duns>",
                "state": "<state>",
                "market": "<market>",
                "region": "<region>",
                "country": "<country>",
                "geoFence": "<geo fence>",
                "postalCode": "<postal code>",
                "phoneNumber": "<phone number>",
                "businessUnit": "<business unit>",
                "locationName": "<location name>",
                "locationType": "<location type>",
                "glnAssignedBy": "<gln assigned by>",
                "gpsCoordinates": "<gps coordinates>",
                "streetAddress1": "<street address 1>",
                "streetAddress2": "<street address 2>",
                "isCoveredByGdst": <is covered by gdst>,
                "parentLocationId": "<parent location id>",
                "isPrimaryLocation": <is primary location>,
                "alternateLocationId": "<alternate location id>"
            },
            "foodReceived": [
                {
                    "gtin": "<gtin>",
                    "isFtlItem": <is ftl item>,
                    "packSize": "<pack size>",
                    "packStyle": "<pack style>",
                    "brandName": "<brand name>",
                    "ftlCategory": "<ftl category>",
                    "innerPackUpc": "<inner pack upc>",
                    "productVariety": "<product variety>",
                    "scientificName": "<scientific name>",
                    "itemDescription": "<item description>",
                    "productCommodity": "<product commodity>",
                    "vendorItemCode": "<vendor item code>",
                    "alternateItemCode": "<alternate item code>",
                    "quantity": <quantity>,
                    "acceptableSpeciesName": "<acceptable species name>",
                    "caseGtin": "<case gtin>",
                    "productId": "<product id>",
                    "harvestDate": "<harvest date>",
                    "lotCode": "<lot code>",
                    "quantityUom": "<quantity uom>",
                    "documentLineNumber": "<document line number>",
                    "packagingDate": "<packaging date>",
                    "expirationDate": "<expiration date>",
                    "productionDate": "<production date>",
                    "bestBeforeDate": "<best before date>"
                }
            ]
        }
    ],
    "empty": <is page empty>,
    "first": <is first page>,
    "last": <is last page>,
    "number": <page number>,
    "numberOfElements": <number of elements>,
    "pageable": {
        "empty": <is page empty>,
        "offset": <offset size>,
        "pageNumber": <page number>,
        "pageSize": <page size>,
        "paged": <is paged>,
        "sort": {
            "empty": <is page empty>,
            "sorted": <is sorted>,
            "unsorted": <is unsorted>
        },
        "unpaged": <is unpaged>
    },
    "size": <page size>,
    "sort": {
        "empty": <is empty>,
        "sorted": <is sorted>,
        "unsorted": <is unsorted>
    },
    "totalElements": <total elements>,
    "totalPages": <total pages>
}

Content​

  • id (uuid): The id of the first land based receiver event
  • dataProviderVendorId (string): The ID of the data provider
  • dataProviderVendorName (string): The name of the data provider
  • eventDateTime (datetime): Date and time of the event
  • documentNumber (string): The document number for the first land based receiver event
  • harvestDateStart (string): Date when harvesting of seafood began.
  • harvestDateEnd (string): Date when harvesting of seafood was completed.
  • harvestLocation (object): The harvest location for the first land based receiver event (see Location object structure)
  • receiveLocation (object): The receiving location for the first land based receiver event (see Location object structure)
  • foodReceived (array): Array of Foods Received
    • gtin (string): Case-level Global Trade Identification Number (GTIN-14). GS1 GTIN Executive Summary
    • isFtlItem (boolean): Indicates if the item is on the Food Traceability List
    • packSize (string): Size of the pack
    • packStyle (string): Style of the pack
    • brandName (string): Brand name
    • ftlCategory (string): Category on the Food Traceability List
    • innerPackUpc (string): Point of sale barcode, may be GTIN-8, GTIN-12, GTIN-13, or GTIN-14. GS1 GTIN Executive Summary
    • productVariety (string): Variety of the product
    • scientificName (string): Scientific name
    • itemDescription (string): Description of the item
    • productCommodity (string): Commodity of the product
    • vendorItemCode (string): This is the item code / product id provided by the supplier
    • alternateItemCode (string): Alternate item code
    • quantity (number): Quantity produced
    • acceptableSpeciesName (string): Acceptable species name
    • caseGtin (string): GTIN of the case
    • productId (string): Product ID
    • harvestDate (date): Harvest date
    • lotCode (string): Lot code
    • quantityUom (string): Unit of measure for the quantity
    • documentLineNumber (string): Received document line number
    • packagingDate (date): Packaging date
    • expirationDate (date): Expiration date
    • productionDate (date): Production date
    • bestBeforeDate (date): Best before date
    • vendorItemCode (string): This is the item code / product id provided for the supplier

Location Object​

The location object contains information about the location where the first land based receiver event occurred:

  • id (string): Location identifier
  • gln (string): GS1 Global Location Number, a 13-digit string. GS1 GTIN Executive Summary
  • city (string): City of the location
  • duns (string): DUNS number
  • state (string): State of the location
  • market (string): Market identifier
  • region (string): Region identifier
  • country (string): Country of the location
  • geoFence (string): Geo-fence coordinates
  • postalCode (string): Postal code
  • phoneNumber (string): Phone number
  • businessUnit (string): Business unit identifier
  • locationName (string): Name of the location
  • locationType (string): Type of the location
  • glnAssignedBy (string): Entity that assigned the GLN
  • gpsCoordinates (string): GPS coordinates
  • streetAddress1 (string): Primary street address
  • streetAddress2 (string): Secondary street address
  • isCoveredByGdst (boolean): Indicates if the location is covered by GDST
  • parentLocationId (string): Parent location ID
  • isPrimaryLocation (boolean): Indicates if this is the primary location
  • alternateLocationId (string): Alternate location ID

Pageable​

  • pageable (object)
    • pageNumber (number): The current page number in the page series. Index 0 is first page
    • pageSize (number): The number of events contained in the page
    • offset (number): If there is an offset specified on there return results this will be populates. Default is 0
    • unpaged (boolean): If the record set is unpaged then true else false
    • paged (boolean): If the record set is paged then true else false
    • sort (object)
      • unsorted (boolean): If the record set is unsorted then true else false
      • sorted (boolean): If the record set is sorted then true else false
      • empty (boolean): If the record set is empty then true else false
  • totalPages (number): The total amount of pages that contain all events in the query
  • totalElements (number): The total amount of events in the query
  • last (boolean): If the page is the last in the series then true else false
  • numberOfElements (number): The total amount of events in the table
  • size (number): The number of events contained in the page
  • number (number): The current page number in the page series
  • sort (object)
    • unsorted (boolean): If the record set is unsorted then true else false
    • sorted (boolean): If the record set is sorted then true else false
    • empty (boolean): If the record set is empty then true else false
  • first (boolean): If the page is the first in the series then true else false
  • empty (boolean): If the page is empty then true else false